/**
 * 
 */
package com.thinkbiganalytics.metadata.api;

/*-
 * #%L
 * kylo-metadata-api
 * %%
 * Copyright (C) 2017 - 2018 ThinkBig Analytics, a Teradata Company
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

/**
 * Identifies a system-level entity that has a "system name" that is distinct from its title and description.
 */
public interface SystemEntity {

    /**
     * @return the system name of the entity (usually immutable)
     */
    String getSystemName();
    
    /**
     * @param name the new system name
     */
    void setSystemName(String name);

    /**
     * @return the title
     */
    String getTitle();

    /**
     * @param title the new title
     */
    void setTitle(String title);
    
    /**
     * @return the description
     */
    String getDescription();
    
    /**
     * @param description the new description
     */
    void setDescription(String description);

}
